// Copyright 2007 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.enterprise.onebox.apps;

/**
 * This interface describes the role of a provider of OneBox results.
 */
public interface SimpleOneBoxProvider {
  /**
   * The three parameters passed to this function are simple those passed to the
   * servlet and thus have the same semantics.
   * 
   * A return value of null is understood as a convenient way to produce no
   * results.  Only if there are more than zero items in the results list will
   * any results be visible on the results page.
   */
  SimpleOneBoxResults getResults(String query, String userName, String password);
}
